/*
 * Funambol is a mobile platform developed by Funambol, Inc. 
 * Copyright (C) 2003 - 2007 Funambol, Inc.
 * 
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU Affero General Public License version 3 as published by
 * the Free Software Foundation with the addition of the following permission 
 * added to Section 15 as permitted in Section 7(a): FOR ANY PART OF THE COVERED
 * WORK IN WHICH THE COPYRIGHT IS OWNED BY FUNAMBOL, FUNAMBOL DISCLAIMS THE 
 * WARRANTY OF NON INFRINGEMENT  OF THIRD PARTY RIGHTS.
 * 
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more
 * details.
 * 
 * You should have received a copy of the GNU Affero General Public License 
 * along with this program; if not, see http://www.gnu.org/licenses or write to
 * the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301 USA.
 * 
 * You can contact Funambol, Inc. headquarters at 643 Bair Island Road, Suite 
 * 305, Redwood City, CA 94063, USA, or at email address info@funambol.com.
 * 
 * The interactive user interfaces in modified source and object code versions
 * of this program must display Appropriate Legal Notices, as required under
 * Section 5 of the GNU Affero General Public License version 3.
 * 
 * In accordance with Section 7(b) of the GNU Affero General Public License
 * version 3, these Appropriate Legal Notices must retain the display of the
 * "Powered by Funambol" logo. If the display of the logo is not reasonably 
 * feasible for technical reasons, the Appropriate Legal Notices must display
 * the words "Powered by Funambol".
 */

#ifndef INCL_NOTE_SYNC_SOURCE
#define INCL_NOTE_SYNC_SOURCE

#include "base/fscapi.h"
#include "spds/constants.h"
#include "spds/SyncItem.h"
#include "spds/SyncMap.h"
#include "spds/SyncStatus.h"
#include "spds/SyncSource.h"
#include "PIMItem.h"
#include "spds/SyncSourceConfig.h"
#include "NoteDataStore.h"
#include "NoteChangesTracker.h"
#include "NoteDataConverter.h"

class NoteSyncSource : public SyncSource {

private:

    SyncItem* transformIntoSyncItem(const char* identifier, Note& n);

protected:

    SyncSourceConfig ssc;
    NoteDataStore* nds;
    NoteDataConverter* ndc;
    NoteChangesTracker* nct;

public:
    NoteSyncSource(SyncSourceConfig& sc, PIMDataStore& ds, PIMDataConverter& dc, ChangesTracker& ct);

    ~NoteSyncSource();


    /// Used to access configuration of SS
    const SyncSourceConfig& getConfig() const;
    SyncSourceConfig& getConfig();

    int beginSync();
    int endSync();

    void setItemStatus(const char* key, int status);
    void assign(NoteSyncSource& s);
    //ArrayElement* clone();
    int removeAllItems();

    // --------- Methods to get syncItems from Client --------------
    SyncItem* getFirstItem();
    SyncItem* getNextItem ();

    SyncItem* getFirstNewItem();
    SyncItem* getNextNewItem ();
    SyncItem* getFirstUpdatedItem();
    SyncItem* getNextUpdatedItem ();

    SyncItem* getFirstDeletedItem();
    SyncItem* getNextDeletedItem ();

    SyncItem* getFirstItemKey();
    SyncItem* getNextItemKey();


    // --------- Methods to set syncItems into Client --------------
    int addItem   (SyncItem& item);
    int updateItem(SyncItem& item);
    int deleteItem(SyncItem& item);


};
#endif
